Carbon


KCGetStatus

Header: Keychain.h Carbon status: Under Evaluation

Obtains the status of a keychain.

OSStatus KCGetStatus (
    KCRef keychain, 
    UInt32 *keychainStatus
);
keychain

A pointer to the keychain reference whose status you wish to determine. Pass NULL to obtain the status of the default keychain.

keychainStatus

On return, a pointer to the status of the specified keychain. The returned value is a 32-bit field whose meaning you can determine by comparing it to a mask of predefined constants. See “Keychain Status Mask Constants” for a description of this mask.

function result

A result code. The result code errKCNoSuchKeychain indicates that the specified keychain could not be found. The result code errKCInvalidKeychain indicates that the specified keychain is invalid.

VERSION NOTES

Available beginning with Keychain Manager 1.0.

AVAILABILITY

Under evaluation for Carbon. Available in CarbonLib 1.0 and later when KeychainLib 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by KeychainLib 1.0 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)